<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Class: TunecoreDirect::Request</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Class</strong></td>
          <td class="class-name-in-header">TunecoreDirect::Request</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../../files/tunecore_direct/request_rb.html">
                tunecore_direct/request.rb
                </a>
        <br />
            </td>
        </tr>

        <tr class="top-aligned-row">
            <td><strong>Parent:</strong></td>
            <td>
                <a href="Base.html">
                TunecoreDirect::Base
               </a>
            </td>
        </tr>
        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">

    <div id="description">
      <p>
This class includes all the methods that you have to interact with the
TuneCore web service.
</p>

    </div>


   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000031">create_album</a>&nbsp;&nbsp;
      <a href="#M000030">create_person</a>&nbsp;&nbsp;
      <a href="#M000032">create_song</a>&nbsp;&nbsp;
      <a href="#M000033">get_album</a>&nbsp;&nbsp;
      <a href="#M000034">get_albums</a>&nbsp;&nbsp;
      <a href="#M000036">get_people</a>&nbsp;&nbsp;
      <a href="#M000035">get_person</a>&nbsp;&nbsp;
      <a href="#M000037">takedown_album</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->
    <div id="includes">
      <h3 class="section-bar">Included Modules</h3>

      <div id="includes-list">
        <span class="include-name">TunecoreDirect</span>
      </div>
    </div>

    <div id="section">





      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000031" class="method-detail">
        <a name="M000031"></a>

        <div class="method-heading">
          <a href="Request.src/M000031.html" target="Code" class="method-signature"
            onclick="popupCode('Request.src/M000031.html');return false;">
          <span class="method-name">create_album</span><span class="method-args">( params={} )</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Creates this new <a href="Album.html">Album</a> at TuneCore
</p>
        </div>
      </div>

      <div id="method-M000030" class="method-detail">
        <a name="M000030"></a>

        <div class="method-heading">
          <a href="Request.src/M000030.html" target="Code" class="method-signature"
            onclick="popupCode('Request.src/M000030.html');return false;">
          <span class="method-name">create_person</span><span class="method-args">(email, password, name, phone_number, country, postal_code=nil)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Creates a new account at Tunecore
</p>
        </div>
      </div>

      <div id="method-M000032" class="method-detail">
        <a name="M000032"></a>

        <div class="method-heading">
          <a href="Request.src/M000032.html" target="Code" class="method-signature"
            onclick="popupCode('Request.src/M000032.html');return false;">
          <span class="method-name">create_song</span><span class="method-args">( params={} )</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Creates this new <a href="Song.html">Song</a> at TuneCore
</p>
        </div>
      </div>

      <div id="method-M000033" class="method-detail">
        <a name="M000033"></a>

        <div class="method-heading">
          <a href="Request.src/M000033.html" target="Code" class="method-signature"
            onclick="popupCode('Request.src/M000033.html');return false;">
          <span class="method-name">get_album</span><span class="method-args">(album_id)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Returns <a href="Response.html">Response</a> that will contain an <a
href="Album.html">Album</a>
</p>
        </div>
      </div>

      <div id="method-M000034" class="method-detail">
        <a name="M000034"></a>

        <div class="method-heading">
          <a href="Request.src/M000034.html" target="Code" class="method-signature"
            onclick="popupCode('Request.src/M000034.html');return false;">
          <span class="method-name">get_albums</span><span class="method-args">(person_id=nil)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Returns a <a href="Response.html">Response</a> that will contain many <a
href="Album.html">Album</a> objects
</p>
        </div>
      </div>

      <div id="method-M000036" class="method-detail">
        <a name="M000036"></a>

        <div class="method-heading">
          <a href="Request.src/M000036.html" target="Code" class="method-signature"
            onclick="popupCode('Request.src/M000036.html');return false;">
          <span class="method-name">get_people</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Returns an array of <a href="Person.html">Person</a> objects associated
with the current API key.
</p>
        </div>
      </div>

      <div id="method-M000035" class="method-detail">
        <a name="M000035"></a>

        <div class="method-heading">
          <a href="Request.src/M000035.html" target="Code" class="method-signature"
            onclick="popupCode('Request.src/M000035.html');return false;">
          <span class="method-name">get_person</span><span class="method-args">(person_id)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Returns a <a href="Person.html">Person</a> object for the given id
</p>
        </div>
      </div>

      <div id="method-M000037" class="method-detail">
        <a name="M000037"></a>

        <div class="method-heading">
          <a href="Request.src/M000037.html" target="Code" class="method-signature"
            onclick="popupCode('Request.src/M000037.html');return false;">
          <span class="method-name">takedown_album</span><span class="method-args">(album_id)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Sends a takedown request for this album
</p>
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>